Skip to content

/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}

Request

Get virtual ledger

Security
httpAuth
Path
domainIdstring, (uuid)required
virtualLedgerIdstring, (uuid)required
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/v1.42/devbox/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring, (uuid)required
aliasstring, non-emptyrequired
depositIdentificationStrategyobjectrequired
exclusionListArray of objectsrequired
metadataobjectrequired
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "alias": "string",
  "depositIdentificationStrategy": {
    "type": "MaximizeSegregation"
  },
  "exclusionList": [
    { … }
  ],
  "metadata": {
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastModifiedAt": "2019-08-24T14:15:22Z",
    "customProperties": { … }
  }
}